home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
IRIX Base Documentation 1998 November
/
IRIX 6.5.2 Base Documentation November 1998.img
/
usr
/
share
/
catman
/
p_man
/
cat3
/
Xm
/
XmDropTransfer.z
/
XmDropTransfer
Wrap
Text File
|
1998-10-30
|
13KB
|
199 lines
XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))
NNNNAAAAMMMMEEEE
XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr - The DropTransfer widget class
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
#include <Xm/DragDrop.h>
VVVVEEEERRRRSSSSIIIIOOOONNNN
This page documents Motif 2.1.
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
DropTransfer provides a set of resources that identifies the
procedures and associated information required by the
toolkit in order to process and complete a drop transaction.
Clients should not explicitly create a DropTransfer widget.
Instead, a client initiates a transfer by calling
XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrSSSSttttaaaarrrrtttt, which initializes and returns a
DropTransfer widget. If this function is called within an
XXXXmmmmNNNNddddrrrrooooppppPPPPrrrroooocccc callback, the actual transfers are initiated
after the callback returns. Even if no data needs to be
transferred, XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrSSSSttttaaaarrrrtttt needs to be called
(typically with no arguments, or just setting
XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrSSSSttttaaaattttuuuussss) to finish the drag and drop transaction.
The XXXXmmmmNNNNddddrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrssss resource specifies a transfer list that
describes the requested target types for the source data. A
transfer list is an array of
XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyyRRRReeeeccccstructures, each of which identifies a
target type. The transfer list is analogous to the MULTIPLE
selections capability defined in the _I_n_t_e_r-_C_l_i_e_n_t
_C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l(ICCCM).
The DropTransfer resource, XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrPPPPrrrroooocccc, specifies a
transfer procedure of type XtSelectionCallbackProc that
delivers the requested selection data. This procedure
operates in conjunction with the underlying Xt selection
capabilities and is called for each target in the transfer
list. Additional target types can be requested after a
transfer is initiated by calling the XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrAAAAdddddddd
function.
SSSSttttrrrruuuuccccttttuuuurrrreeeessss
An XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyy is a pointer to the following
structure of type XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyyRRRReeeecccc, which identifies a
selection target associated with a given drop transaction:
typedef struct
{
XtPointer _c_l_i_e_n_t__d_a_t_a;;;;
AAAAttttoooommmm _t_a_r_g_e_t;;;;
}}}} XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyyRRRReeeecccc,,,, ****XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyy;;;;
_c_l_i_e_n_t__d_a_t_a
Page 1 (printed 10/24/98)
XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))
Specifies any additional information required by
this selection target
_t_a_r_g_e_t Specifies a selection target associated with the
drop operation
CCCCllllaaaasssssssseeeessss
DropTransfer inherits behavior and a resource from OOOObbbbjjjjeeeecccctttt.
The class pointer is _x_m_D_r_o_p_T_r_a_n_s_f_e_r_O_b_j_e_c_t_C_l_a_s_s.
The class name is XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr.
NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
The following table defines a set of widget resources used
by the programmer to specify data. The programmer can also
set the resource values for the inherited classes to set
attributes for this widget. To reference a resource by name
or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
prefix and use the remaining letters. To specify one of the
defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove
the XXXXmmmm prefix and use the remaining letters (in either
lowercase or uppercase, but include any underscores between
words). The codes in the access column indicate if the given
resource can be set at creation time (C), set by using
XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
not applicable (N/A).
XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss
XmNdropTransfers XmCDropTransfers XmDropTransferEntryRec * NULL CG
XmNincremental XmCIncremental Boolean False CSG
XmNnumDropTransfers XmCNumDropTransfers Cardinal 0 CSG
XmNtransferProc XmCTransferProc XtSelectionCallbackProc NULL CSG
XmNtransferStatus XmCTransferStatus unsigned char XmTRANSFER_SUCCESS CSG
XXXXmmmmNNNNddddrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrssss
Specifies the address of an array of drop transfer
entry records. The drop transfer is complete when
all the entries in the list have been processed.
XXXXmmmmNNNNiiiinnnnccccrrrreeeemmmmeeeennnnttttaaaallll
Specifies a Boolean value that indicates whether
the transfer on the receiver side uses the Xt
incremental selection transfer mechanism described
in _X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s-_C _L_a_n_g_u_a_g_e _I_n_t_e_r_f_a_c_e. If
the value is True, the receiver uses incremental
transfer; if the value is False, the receiver uses
atomic transfer.
XXXXmmmmNNNNnnnnuuuummmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrssss
Specifies the number of entries in
Page 2 (printed 10/24/98)
XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))
XXXXmmmmNNNNddddrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrssss. If this resource is set to 0 at
any time, the transfer is considered complete. The
value of XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrSSSSttttaaaattttuuuussss determines the
completion handshaking process.
XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrPPPPrrrroooocccc
Specifies a procedure of type
_X_t_S_e_l_e_c_t_i_o_n_C_a_l_l_b_a_c_k_P_r_o_c that delivers the
requested selection values. The _w_i_d_g_e_t argument
passed to this procedure is the DropTransfer
widget. The selection atom passed is _MOTIF_DROP.
For additional information on selection callback
procedures, see _X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s-_C _L_a_n_g_u_a_g_e
_I_n_t_e_r_f_a_c_e.
XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrSSSSttttaaaattttuuuussss
Specifies the current status of the drop transfer.
The client updates this value when the transfer
ends and communicates the value to the initiator.
The possible values are
XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____SSSSUUUUCCCCCCCCEEEESSSSSSSS
The transfer succeeded.
XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____FFFFAAAAIIIILLLLUUUURRRREEEE
The transfer failed.
IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
DropTransfer inherits behavior and a resource from OOOObbbbjjjjeeeecccctttt.
For a complete description of this resource, refer to the
OOOObbbbjjjjeeeecccctttt reference page.
OOOObbbbjjjjeeeecccctttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss
XmNdestroyCallback XmCCallback XtCallbackList NULL C
RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
OOOObbbbjjjjeeeecccctttt(3), XXXXmmmmDDDDiiiissssppppllllaaaayyyy(3), XXXXmmmmDDDDrrrraaaaggggCCCCoooonnnntttteeeexxxxtttt(3), XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn(3),
XXXXmmmmDDDDrrrrooooppppSSSSiiiitttteeee(3), XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrAAAAdddddddd(3), and
XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrSSSSttttaaaarrrrtttt(3).
Page 3 (printed 10/24/98)